﻿/*
 * NotConformableException.cs
 * 
 * Copyright (c) 2003-2005, dnAnalytics. All rights reserved.
*/

using System;
using System.Runtime.Serialization;
using dnAnalytics.LinearAlgebra;

namespace dnAnalytics.Exceptions {
	///<summary>The exception is thrown when a <see cref="Matrix"/> with the wrong dimensions is used.</summary>
	[Serializable()]
	public sealed class NotConformableException : dnAnalyticsArgumentException {

		///<summary>Initializes a new instance of the <b>NotConformableException</b> class.</summary>
		public NotConformableException() : base() { }

		///<summary>Initializes a new instance of the <b>NotConformableException</b> class with a specified error message.</summary>
		///<param name="message">The error message that explains the reason for the exception.</param>
		public NotConformableException( String message ) : base( message ) { }

		///<summary>Initializes a new instance of the <b>NotConformableException</b> class with a specified error message 
		///and a reference to the inner exception that is the cause of this exception.</summary>
		///<param name="message">The error message that explains the reason for the exception.</param>
		///<param name="inner">The exception that is the cause of the current exception. 
		///If the innerException parameter is not a null reference, the current exception is raised in a <b>catch</b> block 
		///that handles the inner exception.</param>
		public NotConformableException( String message, System.Exception inner ) : base( message, inner ) { }

		///<summary>Initializes a new instance of the <b>NotConformableException</b> class with serialized data.</summary>
		///<param name="info">The error message that explains the reason for the exception.</param>
		///<param name="context">The error message that explains the reason for the exception.</param>
		private NotConformableException( SerializationInfo info, StreamingContext context ) : base( info, context ) { }

        ///<summary>Initializes a new instance of the <b>NotConformableException</b> class with a specified error message.</summary>
        ///<param name="message">The error message that explains the reason for the exception.</param>
        ///<param name="parameter">The parameter that caused the exception.</param>
        public NotConformableException(String parameter, String message) : base(message, parameter) { }

        ///<summary>Initializes a new instance of the <b>NotConformableException</b> class with a specified error message 
        ///and a reference to the inner exception that is the cause of this exception.</summary>
        ///<param name="message">The error message that explains the reason for the exception.</param>
        ///<param name="parameter">The parameter that caused the exception.</param>
        ///<param name="inner">The exception that is the cause of the current exception. 
        ///If the innerException parameter is not a null reference, the current exception is raised in a <b>catch</b> block 
        ///that handles the inner exception.</param>
        public NotConformableException(String parameter, String message, System.Exception inner) : base(message, parameter, inner) { }
	}
}